Skip to main content

Gift card code lookup

Details​

Used to lookup a gift card with a specific code.

URL : <base_url>/giftcards/lookup/{gift_card_code}

Method : GET

Authentication required : YES

Request parameters​

In the request URL, provide the following parameter in the URL

ParameterTypeExampleDescription
codestringABC76DIt uniquely identifies a gift card.

Success Response​

Code : 200 OK

Content :

{
  "data": {
    "item": "Item 1",
    "active": true,
    "expires": null,
    "value": 5000,
    "balance": 5000,
    "pin_required": true
  }
}

Error Responses​

Condition : Invalid gift card code.

Code : 400 BAD REQUEST

Content :

{
  "message": "The given data was invalid.",
  "errors": {
    "code": "Invalid giftcard code: 333"
  }
}

End